package com.uw.scenic.config;
import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.ParameterBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.schema.ModelRef;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.service.Parameter;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;

import java.util.ArrayList;
import java.util.List;


/**
 * swagger2配置
 * @author yls
 * @date 2021-03-01
 */
@ConditionalOnProperty(name = "swagger.is.enable", havingValue = "true")
@Configuration
@EnableSwagger2
public class Swagger2 {

    //http://localhost:8088/swagger-ui.html
    //http://localhost:8088/doc.html
    //配置swagger2核心配置 docket
    @Bean
    public Docket createRestApi(){
        //header
        ParameterBuilder tokenPar = new ParameterBuilder();
        tokenPar.name("token").description("user login token")
         .modelRef(new ModelRef("string")).parameterType("header")
                .required(false).build(); //header中的ticket参数非必填，传空也可以

        List<Parameter> pars = new ArrayList<Parameter>();
        pars.add(tokenPar.build());//根据每个方法名也知道当前方法在设置什么参数

        return new Docket(DocumentationType.SWAGGER_2)           //指定api类型为swagger2
                .apiInfo(apiInfo())      //定义api文档汇总信息
                .select()
                .apis(RequestHandlerSelectors.
                        basePackage("com.uw.scenic"))           //指定扫描的包
                .paths(PathSelectors.any())
                .build()
                .globalOperationParameters(pars)    //全局参数
                .pathMapping("/");
    }

    private ApiInfo apiInfo(){
        return new ApiInfoBuilder()
                .title("旅游景区用户微服务api")     //文档页标题
                .contact(new Contact("yls",
                        "http://www.baidu.com","963306511@immoc.com"))  //联系人
                .description("旅游景区用户微服务api文档")          //详细信息
                .version("1.0.1")   //文档版本号
                .termsOfServiceUrl("https://www.baidu.com")            //网址地址
                .build();
    }


}
